Skip to content

docs: add comprehensive testing prerequisites and testutil documentation#46

Merged
mrhillsman merged 1 commit into
mainfrom
docs/add-testing-prerequisites
May 21, 2026
Merged

docs: add comprehensive testing prerequisites and testutil documentation#46
mrhillsman merged 1 commit into
mainfrom
docs/add-testing-prerequisites

Conversation

@mrhillsman

@mrhillsman mrhillsman commented May 20, 2026

Copy link
Copy Markdown
Contributor

Add detailed cluster prerequisites section to development.md with:

  • Minimum OpenShift and CNV version requirements
  • Kubeconfig setup and verification steps
  • Resource consumption and runtime estimates
  • Common test failures and troubleshooting

Add testutil package documentation including:

  • Core function reference with signatures
  • Usage pattern examples
  • Testing instructions

Enhance godoc comments in testutil package with:

  • Detailed parameter and return value explanations
  • Usage examples for complex functions
  • Kubeconfig resolution order
  • Timeout recommendations

Update README.md prerequisites with specific version requirements and link to detailed cluster setup guide.

Update test organization table with coverage metrics.

Fixes #13

@exe-prow-github-app exe-prow-github-app Bot requested review from caxu-rh and itroyano May 20, 2026 20:19
@exe-prow-github-app

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mrhillsman

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@exe-prow-github-app exe-prow-github-app Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 20, 2026
@mrhillsman mrhillsman force-pushed the docs/add-testing-prerequisites branch 2 times, most recently from f46bdfa to a4512db Compare May 20, 2026 20:23
Add detailed cluster prerequisites section to development.md with:
- Minimum OpenShift and CNV version requirements
- Kubeconfig setup and verification steps
- Resource consumption and runtime estimates
- Common test failures and troubleshooting

Add testutil package documentation including:
- Core function reference with signatures
- Usage pattern examples
- Testing instructions

Enhance godoc comments in testutil package with:
- Detailed parameter and return value explanations
- Usage examples for complex functions
- Kubeconfig resolution order
- Timeout recommendations

Update README.md prerequisites with specific version requirements
and link to detailed cluster setup guide.

Update test organization table with coverage metrics.

Fixes #13

Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
@mrhillsman mrhillsman force-pushed the docs/add-testing-prerequisites branch from d7f96e4 to a3df5b6 Compare May 21, 2026 23:15
@mrhillsman mrhillsman merged commit ec36d77 into main May 21, 2026
3 of 4 checks passed
@mrhillsman mrhillsman deleted the docs/add-testing-prerequisites branch May 22, 2026 06:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Integration and E2E tests have no documented cluster prerequisites or setup instructions

1 participant